'\" te
.\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH BORDER 3XCURSES "Jun 5, 2002"
.SH NAME
border, box, wborder \- add a single-byte border to a window
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]

\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]

#include <curses.h>

\fBint\fR \fBborder\fR(\fBchtype\fR \fIls\fR, \fBchtype\fR \fIrs\fR, \fBchtype\fR \fIts\fR, \fBchtype\fR \fIbs\fR, \fBchtype\fR \fItl\fR,
     \fBchtype\fR \fItr\fR, \fBchtype\fR \fIbl\fR, \fBchtype\fR \fIbr\fR);
.fi

.LP
.nf
\fBint\fR \fBwborder\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype\fR \fIls\fR, \fBchtype\fR \fIrs\fR, \fBchtype\fR \fIts\fR, \fBchtype\fR \fIbs\fR,
     \fBchtype\fR \fItl\fR,\fBchtype\fR \fItr\fR, \fBchtype\fR \fIbl\fR, \fBchtype\fR \fIbr\fR);
.fi

.LP
.nf
\fBint\fR \fBbox\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype\fR \fIverch\fR, \fBchtype\fR \fIhorch\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBborder()\fR and \fBwborder()\fR functions draw a border around the
specified window.  All parameters must be single-byte characters whose
rendition can be expressed using only constants beginning with \fBACS_\fR. A
parameter with the value of 0 is replaced by the default value.
.sp

.sp
.TS
box;
c c c
c c c .
Constant Values for Borders
_
Parameter	Default Constant	Default Character
_
\fIverch \fR	\fBACS_VLINE\fR	|
\fIhorch \fR	\fBACS_HLINE\fR	-
\fBls\fR	\fBACS_VLINE\fR	|
\fIrs\fR	\fBACS_VLINE\fR	|
\fIts\fR	\fBACS_HLINE\fR	-
\fIbs\fR	\fBACS_HLINE\fR	-
\fIbl\fR	\fBACS_BLCORNER\fR	+
\fIbr\fR	\fBACS_BRCORNER\fR	+
\fItl\fR	\fBACS_ULCORNER\fR	+
\fBtr\fR	\fBACS_URCORNER\fR	+
.TE

.sp
.LP
The call
.sp
.in +2
.nf
\fBbox(\fR\fIwin\fR,
\fIverch\fR, \fIhorch\fR)
.fi
.in -2

.sp
.LP
is a short form for
.sp
.in +2
.nf
\fBwborder(\fR\fIwin\fR,
\fIverch\fR, \fIverch\fR,
\fIhorch\fR, \fIhorch\fR, 0, 0, 0,
0)
.fi
.in -2

.sp
.LP
When the window is boxed, the bottom and top rows and right and left columns
overwrite existing text.
.SH PARAMETERS
.sp
.ne 2
.na
\fB\fIls\fR\fR
.ad
.RS 9n
Is the character and rendition used for the left side of the border.
.RE

.sp
.ne 2
.na
\fB\fIrs\fR\fR
.ad
.RS 9n
Is the character and rendition used for the right side of the border.
.RE

.sp
.ne 2
.na
\fB\fIts\fR\fR
.ad
.RS 9n
Is the character and rendition used for the top of the border.
.RE

.sp
.ne 2
.na
\fB\fIbs\fR\fR
.ad
.RS 9n
Is the character and rendition used for the bottom of the border.
.RE

.sp
.ne 2
.na
\fB\fItl\fR\fR
.ad
.RS 9n
Is the character and rendition used for the top-left corner of the border.
.RE

.sp
.ne 2
.na
\fB\fItr\fR\fR
.ad
.RS 9n
Is the character and rendition used for the top-right corner of the border.
.RE

.sp
.ne 2
.na
\fB\fIbl\fR\fR
.ad
.RS 9n
Is the character and rendition used for the bottom-left corner of the border.
.RE

.sp
.ne 2
.na
\fB\fIbr\fR\fR
.ad
.RS 9n
Is the character and rendition used for the bottom-right corner of the border.
.RE

.sp
.ne 2
.na
\fB\fIwin\fR\fR
.ad
.RS 9n
Is the pointer to the window in which the border or box is to be drawn.
.RE

.sp
.ne 2
.na
\fB\fIverch\fR\fR
.ad
.RS 9n
Is the character and rendition used for the left and right columns of the box.
.RE

.sp
.ne 2
.na
\fB\fIhorch\fR\fR
.ad
.RS 9n
Is the character and rendition used for the top and bottom rows of the box.
.RE

.SH RETURN VALUES
.sp
.LP
On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
.SH ERRORS
.sp
.LP
None.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Standard
_
MT-Level	Unsafe
.TE

.SH SEE ALSO
.sp
.LP
.BR add_wch (3XCURSES),
.BR addch (3XCURSES),
.BR attr_get (3XCURSES),
.BR attroff (3XCURSES),
.BR border_set (3XCURSES),
.BR libcurses (3XCURSES),
.BR attributes (7),
.BR standards (7)
